home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 August: Tool Chest / Dev.CD Aug 98 TC.toast / Tool Chest / Testing & Debugging / Virtual User / Virtual User Current Release / Examples / External Tool Templates / CPlus Tool Template / Request.cp < prev    next >
Encoding:
Text File  |  1998-06-04  |  25.1 KB  |  870 lines  |  [TEXT/MPS ]
  1. /*
  2.  *    File:        Request.cp
  3.  *
  4.  *    Contains:    xxx put contents here xxx
  5.  *
  6.  *    Written by:    Rick Violet
  7.  *
  8.  *    Copyright:    © 1992 by Apple Computer, Inc., all rights reserved.
  9.  *
  10.  *    Change History (most recent first):
  11.  *
  12.  *                11/18/92    RV        xxx put comment here xxx
  13.  *                06/19/94    SBR        Added ExtractValueFromNthParam methods
  14.  *                09/11/94    SBR        Added ExtractValueFromNthParam for Boolean
  15.  *
  16.  *    To Do:
  17.  */
  18.  
  19. #ifndef        __Request__
  20. #include        "Request.h"
  21. #endif
  22.  
  23. #ifndef        __RequestDispatcher__
  24. #include        "RequestDispatcher.h"
  25. #endif
  26.  
  27. #ifndef        __ERRORS__
  28. #include        <Errors.h>
  29. #endif
  30.  
  31. /*SBR Hacked these in 05/24/94*/
  32. /*
  33. #ifndef        __STREAM__
  34. #include        "Stream.h"
  35. #endif
  36. */
  37.  
  38. #ifndef        __STRINGS__
  39. #include        <Strings.h>
  40. #endif
  41.  
  42. #ifndef        __TEXTUTILS__
  43. #include        <TextUtils.h>
  44. #endif
  45.  
  46. //—————————————————————————————————————————————————————————————————————————————————————
  47. //                                Global Variables
  48. //—————————————————————————————————————————————————————————————————————————————————————
  49. extern    RequestDispatcher*        gTheRequestDispatcher;
  50. extern    ThreadID                gRequestDispatcherThreadID;
  51.  
  52. //—————————————————————————————————————————————————————————————————————————————————————
  53. //    Request::Request    -    constructor.
  54. //—————————————————————————————————————————————————————————————————————————————————————
  55. Request::Request()
  56. {
  57.     fWhichService         = nil;            //————    No Request name yet
  58.     fParamList             = nil;            //————    create empty list of parameters
  59.     fReturnValue         = nil;            //————    create empty return value
  60.     fErrorCode             = noErr;        //————    No errors yet
  61.     fErrorMessage         = nil;            //————    No error message yet
  62.     fCanceled             = false;        //————    Not canceled yet
  63.     fRequestIdentifier     = 0;            //————    No identifier yet
  64.  
  65.         /*SBR Hacked this in 10/16/94 */
  66.     fThreadID            = kNoThreadID;    //————    No thread has been assigned yet
  67.     fThreadOptions        = 0;            //————    No thread options have been assigned yet
  68.     fService            = nil;            //————    No service has been assigned
  69. }
  70.  
  71. //—————————————————————————————————————————————————————————————————————————————————————
  72. //    Request::~Request    -    destructor.
  73. //—————————————————————————————————————————————————————————————————————————————————————
  74. Request::~Request()
  75. {
  76.         //————    dispose of fWhichService 
  77.     if( fWhichService != nil )
  78.     {
  79.         delete fWhichService;
  80.     }
  81.  
  82.         //————    dispose of fParamList 
  83.     if( fParamList != nil )
  84.     {
  85.         delete fParamList;
  86.     }
  87.  
  88.         //————    dispose of fReturnValue 
  89.     if( fReturnValue != nil )
  90.     {
  91.         delete fReturnValue;
  92.     }
  93.  
  94.         //————    dispose of fErrorMessage 
  95.     if( fErrorMessage != nil )
  96.     {
  97.         delete fErrorMessage;
  98.     }
  99. }
  100.  
  101. //—————————————————————————————————————————————————————————————————————————————————————
  102. //    Request::Initialize    -    initialize the Request
  103. //—————————————————————————————————————————————————————————————————————————————————————
  104. OSErr
  105. Request::Initialize()
  106. {
  107.         //————    Tell V.U. not to time out for at least kDefaultTimeOutSeconds
  108.     ResetTimeOutCounter();    
  109.         
  110.     return noErr;
  111. }
  112.  
  113. //—————————————————————————————————————————————————————————————————————————————————————
  114. //    Request::HasBeenCanceled    - Check to see if this command has been canceled
  115. //—————————————————————————————————————————————————————————————————————————————————————
  116. Boolean
  117. Request::HasBeenCanceled()
  118. {
  119.     return fCanceled; 
  120. }
  121.  
  122. //—————————————————————————————————————————————————————————————————————————————————————
  123. //    Request::ResetTimeOutCounter - inform V.U. to not let this Request time out
  124. //—————————————————————————————————————————————————————————————————————————————————————
  125. void
  126. Request::ResetTimeOutCounter( unsigned long pNewTimeOutInterval )
  127. {    
  128.         //————    Set up the Time Manager task to fire again at a later time
  129.     if( !HasBeenCanceled() )
  130.     {
  131.             //————    Keep Track of when we'll time out
  132.         fSendResetTicks = TickCount() + (pNewTimeOutInterval * 60);
  133.     }
  134. }
  135.  
  136. //—————————————————————————————————————————————————————————————————————————————————————
  137. //    Request::IsACancelRequest    - Is this a Cancel Request?
  138. //                                    return true if this is a cancel service request
  139. //—————————————————————————————————————————————————————————————————————————————————————
  140. Boolean
  141. Request::IsACancelRequest()
  142. {
  143.     if( relstring( fWhichService, (char*)kVUAECancelService, false, true ) == 0 )
  144.     {
  145.         return true;
  146.     }
  147.     else
  148.     {
  149.         return false;
  150.     }
  151. }
  152.  
  153. //—————————————————————————————————————————————————————————————————————————————————————
  154. //    Request::IsCancelRequestForThisRequest    - is the cancel request
  155. //        passed in as a parameter for canceling this sevice request object
  156. //—————————————————————————————————————————————————————————————————————————————————————
  157. Boolean
  158. Request::IsCancelRequestForThisRequest( Request* pCancelReq )
  159. {
  160.     long    tReqID;
  161.     
  162.         //————    Get the Identifier of the request to cancel 
  163.         //————    from the Cancel Request object
  164.     tReqID = pCancelReq->GetIdentifierOfRequesttoCancel();
  165.     if( tReqID == fRequestIdentifier )
  166.     {
  167.         return true;
  168.     }
  169.     else
  170.     {
  171.         return false;
  172.     }
  173. }
  174.  
  175.         /*SBR Hacked this in 10/16/94 */
  176. //—————————————————————————————————————————————————————————————————————————————————————
  177. //    Request::CancelThisRequest    - cancel this request
  178. //—————————————————————————————————————————————————————————————————————————————————————
  179. void
  180. Request::CancelThisRequest( )
  181. {
  182.     ThreadID        tReqThreadID;
  183.     ThreadState        tReqThreadState;
  184.     OSErr            tErr;
  185.     
  186.     fCanceled = true;
  187.     
  188.     if( this->IsThreaded() )
  189.     {
  190.             //————    See if the request being canceled is in a stopped thread. If it is, 
  191.             //————    set its state to Ready so it gets time to recognize the cancel.
  192.         tReqThreadID = this->GetThreadID();
  193.  
  194.         tErr = GetThreadState( tReqThreadID, &tReqThreadState );
  195.         if( tErr != noErr )
  196.         {
  197.             DebugStr( "\pRequest::CancelThisRequest- error from GetThreadState" );
  198.             return;
  199.         }
  200.         
  201.         if( tReqThreadState == kStoppedThreadState )
  202.         {
  203.             tErr = SetThreadState( tReqThreadID, kReadyThreadState, kNoThreadID );
  204.             if( tErr != noErr )
  205.             {
  206.                 DebugStr( "\pRequest::CancelThisRequest- error from SetThreadState" );
  207.                 return;
  208.             }
  209.         }
  210.     }
  211. }
  212.  
  213. //—————————————————————————————————————————————————————————————————————————————————————
  214. //    Request::IsThreaded    - Is this Request executing in a different thread?
  215. //—————————————————————————————————————————————————————————————————————————————————————
  216. Boolean
  217. Request::IsThreaded()
  218. {
  219.         //————    gRequestDispatcherThreadID could be kNoThreadID if app is non-threaded
  220.         //————    commented this out to support non-threaded services executed in a 
  221.         //————    separate thread from the RequestDispatcher or Application thread
  222.     return !(( fThreadID == kNoThreadID ) || ( fThreadID == gRequestDispatcherThreadID ));
  223. }
  224.  
  225. //—————————————————————————————————————————————————————————————————————————————————————
  226. //    Request::SetErrorCode    - set the Error code for this request
  227. //—————————————————————————————————————————————————————————————————————————————————————
  228. void
  229. Request::SetErrorCode( OSErr tErr )
  230. {
  231.     fErrorCode = tErr;
  232. }
  233.  
  234. //—————————————————————————————————————————————————————————————————————————————————————
  235. //    Request::SetErrorMessage    - set the Error message for this request
  236. //—————————————————————————————————————————————————————————————————————————————————————
  237. void
  238. Request::SetErrorMessage( char* tErrText )
  239. {
  240.         //————    Keep Request status in sync with the error code
  241.     fErrorMessage = new char[ strlen( tErrText ) + 1];
  242.     if( fErrorMessage )
  243.     {
  244.         strcpy( fErrorMessage, tErrText );
  245.     }
  246. }
  247.  
  248. //—————————————————————————————————————————————————————————————————————————————————————
  249. //    Request::GetNthParam    -    get the Nth parameter
  250. //—————————————————————————————————————————————————————————————————————————————————————
  251. OSErr
  252. Request::GetNthParam( short pIndex, ScriptValuePtr& pValue, ValueKind& pVKind )
  253. {    
  254.     if( fParamList != nil )
  255.     {
  256.         return fParamList->GetNthItem( pIndex, pValue, pVKind ); 
  257.     }
  258.     else
  259.     {
  260.         pVKind = kVUAnyKind;
  261.         pValue = nil;
  262.         return errAEWrongParameters;
  263.     }
  264. }
  265.  
  266. //—————————————————————————————————————————————————————————————————————————————————————
  267. //    Request::GetParamCount    -    return the number of parameters
  268. //—————————————————————————————————————————————————————————————————————————————————————
  269. short
  270. Request::GetParamCount()
  271. {
  272.     if( fParamList != nil )
  273.     {
  274.         return fParamList->GetCount();
  275.     }
  276.     else
  277.     {
  278.         return 0;
  279.     }
  280. }
  281.  
  282. //—————————————————————————————————————————————————————————————————————————————————————
  283. //    Request::SetReturnValue    -    set the return value for this request
  284. //                                        to a Number ScriptValue
  285. //—————————————————————————————————————————————————————————————————————————————————————
  286. void
  287. Request::SetReturnValue( short pNumber )
  288. {
  289.     ScriptValue*    tVal;
  290.     
  291.     tVal = new VUNumber( pNumber );
  292.     fReturnValue = tVal; 
  293. }
  294.  
  295. //—————————————————————————————————————————————————————————————————————————————————————
  296. //    Request::SetReturnValue    -    set the return value for this request
  297. //                                        to a Number ScriptValue
  298. //—————————————————————————————————————————————————————————————————————————————————————
  299. void
  300. Request::SetReturnValue( long pLongNumber )
  301. {
  302.     ScriptValue*    tVal;
  303.     
  304.     tVal = new VULongNumber( pLongNumber );
  305.     fReturnValue = tVal; 
  306. }
  307.  
  308. //—————————————————————————————————————————————————————————————————————————————————————
  309. //    Request::SetReturnValue    -    set the return value for this request
  310. //                                        to a Boolean ScriptValue
  311. //—————————————————————————————————————————————————————————————————————————————————————
  312. void
  313. Request::SetReturnValue( Boolean pFlag )
  314. {
  315.     ScriptValue*    tVal;
  316.     
  317.     tVal = new VUBoolean( pFlag );
  318.     fReturnValue = tVal; 
  319. }
  320.  
  321. //—————————————————————————————————————————————————————————————————————————————————————
  322. //    Request::SetReturnValue    -    set the return value for this request
  323. //                                        to a String ScriptValue
  324. //—————————————————————————————————————————————————————————————————————————————————————
  325. void
  326. Request::SetReturnValue( char* pString )
  327. {
  328.     ScriptValue*    tVal;
  329.     
  330.     tVal = new VUString( pString );
  331.     fReturnValue = tVal; 
  332. }
  333.  
  334. //—————————————————————————————————————————————————————————————————————————————————————
  335. //    Request::SetReturnValue    -    set the return value for this request
  336. //                                        to a List ScriptValue
  337. //—————————————————————————————————————————————————————————————————————————————————————
  338. void
  339. Request::SetReturnValue( ScriptValuePtr pScriptValue )
  340. { 
  341. //    fReturnValue = pScriptValue; 
  342.     fReturnValue = pScriptValue->Clone();
  343. }
  344.  
  345. //—————————————————————————————————————————————————————————————————————————————————————
  346. //    Request::SetReturnValue    -    set the return value for this request
  347. //                                        to a String ScriptValue
  348. //—————————————————————————————————————————————————————————————————————————————————————
  349. void
  350. Request::SetWhichService( char* pServiceText )
  351. {
  352.     fWhichService = new char[ strlen( pServiceText ) + 1 ];
  353.     if( fWhichService == nil )
  354.     {
  355.         SetErrorCode( memFullErr );
  356.         SetErrorMessage( "Failed to allocate string for Request object." );
  357.     }
  358.     else
  359.     {
  360.         strcpy( fWhichService, pServiceText );
  361.     }
  362. }
  363.  
  364. //#######################################################################
  365. //#######################################################################
  366. // The following overloaded request methods were added by Stuart Russell. 
  367. // Search for 'ExtractValueFromNthParam' to find changes to services.
  368. //#######################################################################
  369. //#######################################################################
  370.  
  371. //—————————————————————————————————————————————————————————————————————————————————————
  372. //    Request::ExtractValueFromNthParam    -    Assign a short from integer/string parameters 
  373. //                VU 2.0.1 sends numbers to tools as shorts; VU 2.1 sends them as longs.
  374. //                This method stores integers or strings into a short variable.
  375. //—————————————————————————————————————————————————————————————————————————————————————
  376. OSErr
  377. Request::ExtractValueFromNthParam( short pIndex, short* pShortPtr )
  378. {
  379.     OSErr            tErr;
  380.     ScriptValue*    tParam;
  381.     ValueKind        tKind;
  382.     
  383.         //————    Specify any kind of VUValue at first
  384.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  385.     tKind = kVUAnyKind;                    
  386.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  387.     
  388.     if ( tErr != noErr ) {
  389.         this->SetErrorCode( paramErr );
  390. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  391.         this->SetErrorMessage( "Failed to extract a parameter" );
  392.         return tErr;
  393.     }
  394.     
  395.     switch (tKind)
  396.     {
  397.             //————    try a long first (VU 2.1)
  398.         case kVULongNumberKind:
  399.         {
  400.             *pShortPtr = (short)((VULongNumber*)tParam)->GetNumber();
  401.         }
  402.         break;
  403.         
  404.             //————    try a short next (VU 2.0.1)
  405.         case kVUNumberKind:
  406.         {
  407.             *pShortPtr = ((VUNumber*)tParam)->GetNumber();
  408.         }
  409.         break;
  410.         
  411.             //————    try a string as a last resort
  412.         case kVUStringKind:
  413.         {
  414.             long    tempLong;
  415.             
  416.             stringtonum( ((VUString*)tParam)->GetText(), &tempLong );
  417.             *pShortPtr = (short)tempLong;
  418.         }
  419.         break;
  420.  
  421.  
  422.         default:
  423.         {
  424.             this->SetErrorCode( paramErr );
  425. //            this->SetErrorMessage( form("Error: parameter %d must be an integer or string.",pIndex) );
  426.             this->SetErrorMessage( "Error: parameter must be an integer or string." );
  427.             return paramErr;
  428.         }
  429.     }
  430.     
  431.     return noErr;
  432. }
  433.  
  434.  
  435. //—————————————————————————————————————————————————————————————————————————————————————
  436. //    Request::ExtractValueFromNthParam    -    Assign a long from integer/string parameters 
  437. //                VU 2.0.1 sends numbers to tools as shorts; VU 2.1 sends them as longs.
  438. //                This method stores integers or strings into a long variable.
  439. //—————————————————————————————————————————————————————————————————————————————————————
  440. OSErr
  441. Request::ExtractValueFromNthParam( short pIndex, long* pLongPtr )
  442. {
  443.     OSErr            tErr;
  444.     ScriptValue*    tParam;
  445.     ValueKind        tKind;
  446.     
  447.         //————    Specify any kind of VUValue at first
  448.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  449.     tKind = kVUAnyKind;                    
  450.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  451.     
  452.     if ( tErr != noErr ) {
  453.         this->SetErrorCode( paramErr );
  454. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  455.         this->SetErrorMessage( "Failed to extract a parameter" );
  456.         return tErr;
  457.     }
  458.     
  459.     switch (tKind)
  460.     {
  461.             //————    try a long first (VU 2.1)
  462.         case kVULongNumberKind:
  463.         {
  464.             *pLongPtr = ((VULongNumber*)tParam)->GetNumber();
  465.         }
  466.         break;
  467.         
  468.             //————    try a short next (VU 2.0.1)
  469.         case kVUNumberKind:
  470.         {
  471.             *pLongPtr = (long)((VUNumber*)tParam)->GetNumber();
  472.         }
  473.         break;
  474.         
  475.             //————    try a string as a last resort
  476.         case kVUStringKind:
  477.         {
  478.             long    tempLong;
  479.             
  480.             stringtonum( ((VUString*)tParam)->GetText(), &tempLong );
  481.             *pLongPtr = tempLong;
  482.         }
  483.         break;
  484.  
  485.  
  486.         default:
  487.         {
  488.             this->SetErrorCode( paramErr );
  489. //            this->SetErrorMessage( form("Error: parameter %d must be an integer or string.",pIndex) );
  490.             this->SetErrorMessage( "Error: parameter must be an integer or string." );
  491.             return paramErr;
  492.         }
  493.     }
  494.     
  495.     return noErr;
  496. }
  497.  
  498.  
  499. //—————————————————————————————————————————————————————————————————————————————————————
  500. //    Request::ExtractValueFromNthParam    -    Assign a char[] from a string parameter 
  501. //                This method copies a C string to the place pointed to by a char*.
  502. //—————————————————————————————————————————————————————————————————————————————————————
  503. OSErr
  504. Request::ExtractValueFromNthParam( short pIndex, char *pCharPtr )
  505. {
  506.     OSErr            tErr;
  507.     ScriptValue*    tParam;
  508.     ValueKind        tKind;
  509.     
  510.         //————    Specify any kind of VUValue at first
  511.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  512.     tKind = kVUAnyKind;                    
  513.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  514.     
  515.     if ( tErr != noErr ) {
  516.         this->SetErrorCode( tErr );
  517. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  518.         this->SetErrorMessage( "Failed to extract a parameter" );
  519.         return tErr;
  520.     }
  521.     
  522.     switch (tKind)
  523.     {
  524.             //————    try a string
  525.         case kVUStringKind:
  526.         {
  527.             strcpy( pCharPtr, ((VUString*)tParam)->GetText() );
  528.         }
  529.         break;
  530.         
  531.         default:
  532.         {
  533.             this->SetErrorCode( paramErr );
  534. //            this->SetErrorMessage( form("Error: parameter %d must be a string.",pIndex) );
  535.             this->SetErrorMessage( "Error: parameter must be a string." );
  536.             return paramErr;
  537.         }
  538.     }
  539.     
  540.     return noErr;
  541. }
  542.  
  543.  
  544. //—————————————————————————————————————————————————————————————————————————————————————
  545. //    Request::ExtractValueFromNthParam    -    Assign a CStr255 from a string parameter 
  546. //                This method copies a C string into a CStr255. Conversion is automatic.
  547. //                Note: a CStr255 is physically a Pascal string - see PascalString.cp.
  548. //—————————————————————————————————————————————————————————————————————————————————————
  549. OSErr
  550. Request::ExtractValueFromNthParam( short pIndex, CStr255* pCStr255Ptr )
  551. {
  552.     OSErr            tErr;
  553.     ScriptValue*    tParam;
  554.     ValueKind        tKind;
  555.     
  556.         //————    Specify any kind of VUValue at first
  557.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  558.     tKind = kVUAnyKind;                    
  559.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  560.     
  561.     if ( tErr != noErr ) {
  562.         this->SetErrorCode( tErr );
  563. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  564.         this->SetErrorMessage( "Failed to extract a parameter" );
  565.         return tErr;
  566.     }
  567.     
  568.     switch (tKind)
  569.     {
  570.             //————    try a string
  571.         case kVUStringKind:
  572.         {
  573.             /* overloaded operator = converts it to a Pascal string */
  574.             *pCStr255Ptr = ((VUString*)tParam)->GetText();
  575.         }
  576.         break;
  577.         
  578.         default:
  579.         {
  580.             this->SetErrorCode( paramErr );
  581. //            this->SetErrorMessage( form("Error: parameter %d must be a string.",pIndex) );
  582.             this->SetErrorMessage( "Error: parameter must be a string." );
  583.             return paramErr;
  584.         }
  585.     }
  586.     
  587.     return noErr;
  588. }
  589.  
  590.  
  591. //—————————————————————————————————————————————————————————————————————————————————————
  592. //    Request::ExtractValueFromNthParam    -    Assign a CStr63 from a string parameter 
  593. //                This method copies a C string into a CStr63. Conversion is automatic.
  594. //                Note: a CStr63 is physically a Pascal string - see PascalString.cp.
  595. //—————————————————————————————————————————————————————————————————————————————————————
  596. OSErr
  597. Request::ExtractValueFromNthParam( short pIndex, CStr63* pCStr63Ptr )
  598. {
  599.     OSErr            tErr;
  600.     ScriptValue*    tParam;
  601.     ValueKind        tKind;
  602.     
  603.         //————    Specify any kind of VUValue at first
  604.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  605.     tKind = kVUAnyKind;                    
  606.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  607.     
  608.     if ( tErr != noErr ) {
  609.         this->SetErrorCode( tErr );
  610. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  611.         this->SetErrorMessage( "Failed to extract a parameter" );
  612.         return tErr;
  613.     }
  614.     
  615.     switch (tKind)
  616.     {
  617.             //————    try a string
  618.         case kVUStringKind:
  619.         {
  620.             /* overloaded operator = converts it to a Pascal string */
  621.             *pCStr63Ptr = ((VUString*)tParam)->GetText();
  622.         }
  623.         break;
  624.         
  625.         default:
  626.         {
  627.             this->SetErrorCode( paramErr );
  628. //            this->SetErrorMessage( form("Error: parameter %d must be a string.",pIndex) );
  629.             this->SetErrorMessage( "Error: parameter must be a string." );
  630.             return paramErr;
  631.         }
  632.     }
  633.     
  634.     return noErr;
  635. }
  636.  
  637.  
  638. //—————————————————————————————————————————————————————————————————————————————————————
  639. //    Request::ExtractValueFromNthParam    -    Assign a CStr32 from a string parameter 
  640. //                This method copies a C string into a CStr32. Conversion is automatic.
  641. //                Note: a CStr32 is physically a Pascal string - see PascalString.cp.
  642. //—————————————————————————————————————————————————————————————————————————————————————
  643. OSErr
  644. Request::ExtractValueFromNthParam( short pIndex, CStr32* pCStr32Ptr )
  645. {
  646.     OSErr            tErr;
  647.     ScriptValue*    tParam;
  648.     ValueKind        tKind;
  649.     
  650.         //————    Specify any kind of VUValue at first
  651.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  652.     tKind = kVUAnyKind;                    
  653.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  654.     
  655.     if ( tErr != noErr ) {
  656.         this->SetErrorCode( tErr );
  657. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  658.         this->SetErrorMessage( "Failed to extract a parameter" );
  659.         return tErr;
  660.     }
  661.     
  662.     switch (tKind)
  663.     {
  664.             //————    try a string
  665.         case kVUStringKind:
  666.         {
  667.             /* overloaded operator = converts it to a Pascal string */
  668.             *pCStr32Ptr = ((VUString*)tParam)->GetText();
  669.         }
  670.         break;
  671.         
  672.         default:
  673.         {
  674.             this->SetErrorCode( paramErr );
  675. //            this->SetErrorMessage( form("Error: parameter %d must be a string.",pIndex) );
  676.             this->SetErrorMessage( "Error: parameter must be a string." );
  677.             return paramErr;
  678.         }
  679.     }
  680.     
  681.     return noErr;
  682. }
  683.  
  684.  
  685. //—————————————————————————————————————————————————————————————————————————————————————
  686. //    Request::ExtractValueFromNthParam    -    Assign a CStr31 from a string parameter 
  687. //                This method copies a C string into a CStr31. Conversion is automatic.
  688. //                Note: a CStr31 is physically a Pascal string - see PascalString.cp.
  689. //—————————————————————————————————————————————————————————————————————————————————————
  690. OSErr
  691. Request::ExtractValueFromNthParam( short pIndex, CStr31* pCStr31Ptr )
  692. {
  693.     OSErr            tErr;
  694.     ScriptValue*    tParam;
  695.     ValueKind        tKind;
  696.     
  697.         //————    Specify any kind of VUValue at first
  698.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  699.     tKind = kVUAnyKind;                    
  700.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  701.     
  702.     if ( tErr != noErr ) {
  703.         this->SetErrorCode( tErr );
  704. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  705.         this->SetErrorMessage( "Failed to extract a parameter" );
  706.         return tErr;
  707.     }
  708.     
  709.     switch (tKind)
  710.     {
  711.             //————    try a string
  712.         case kVUStringKind:
  713.         {
  714.             /* overloaded operator = converts it to a Pascal string */
  715.             *pCStr31Ptr = ((VUString*)tParam)->GetText();
  716.         }
  717.         break;
  718.         
  719.         default:
  720.         {
  721.             this->SetErrorCode( paramErr );
  722. //            this->SetErrorMessage( form("Error: parameter %d must be a string.",pIndex) );
  723.             this->SetErrorMessage( "Error: parameter must be a string." );
  724.             return paramErr;
  725.         }
  726.     }
  727.     
  728.     return noErr;
  729. }
  730.  
  731. //—————————————————————————————————————————————————————————————————————————————————————
  732. //    Request::ExtractValueFromNthParam    -    Assign a ScriptValue* from a string parameter.
  733. //                This method stores a ScriptValue* into a ScriptValue* variable. No 
  734. //                copying occurs. The pScriptValuePtrPtr will point to a member of an item
  735. //                in a VUList in the request object. This VUList will be deleted as soon as 
  736. //                your service's ProcessRequest() method returns, so you should extract the
  737. //                contents ASAP if you want to keep them.
  738. //—————————————————————————————————————————————————————————————————————————————————————
  739. OSErr
  740. Request::ExtractValueFromNthParam( short pIndex, ScriptValue** pScriptValuePtrPtr )
  741. {
  742.     OSErr            tErr;
  743.     ScriptValue*    tParam;
  744.     ValueKind        tKind;
  745.     
  746.         //————    Specify any kind of VUValue at first
  747.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  748.     tKind = kVUAnyKind;                    
  749.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  750.     
  751.     if ( tErr != noErr ) {
  752.         this->SetErrorCode( tErr );
  753. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  754.         this->SetErrorMessage( "Failed to extract a parameter" );
  755.         return tErr;
  756.     }
  757.     
  758.     switch (tKind)
  759.     {
  760.             //————    try any kind
  761.         case kVUListKind:
  762.         {
  763.             *pScriptValuePtrPtr = ((ScriptValue*)tParam);
  764.             //*pScriptValuePtrPtr = (ScriptValue*)(tParam->Clone());
  765.         }
  766.         break;
  767.         
  768.         default:
  769.         {
  770.             this->SetErrorCode( paramErr );
  771. //            this->SetErrorMessage( form("Error: parameter %d must be a ScriptValue.",pIndex) );
  772.             this->SetErrorMessage( "Error: parameter must be a ScriptValue." );
  773.             return paramErr;
  774.         }
  775.     }
  776.     
  777.     return noErr;
  778. }
  779.  
  780.  
  781. //—————————————————————————————————————————————————————————————————————————————————————
  782. //    Request::ExtractValueFromNthParam    -    Assign a char* from a string parameter 
  783. //                This method stores a char* into a char* variable. No copying occurs.
  784. //                The pCharPtr will point to a member of an item in a VUList, which may 
  785. //                be deleted at any time, so you should extract the contents ASAP.
  786. //—————————————————————————————————————————————————————————————————————————————————————
  787. OSErr
  788. Request::ExtractValueFromNthParam( short pIndex, char** pCharPtrPtr )
  789. {
  790.     OSErr            tErr;
  791.     ScriptValue*    tParam;
  792.     ValueKind        tKind;
  793.     
  794.         //————    Specify any kind of VUValue at first
  795.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  796.     tKind = kVUAnyKind;                    
  797.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  798.     
  799.     if ( tErr != noErr ) {
  800.         this->SetErrorCode( tErr );
  801. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  802.         this->SetErrorMessage( "Failed to extract a parameter" );
  803.         return tErr;
  804.     }
  805.     
  806.     switch (tKind)
  807.     {
  808.             //————    try a string
  809.         case kVUStringKind:
  810.         {
  811.             *pCharPtrPtr = ((VUString*)tParam)->GetText();
  812.         }
  813.         break;
  814.         
  815.         default:
  816.         {
  817.             this->SetErrorCode( paramErr );
  818. //            this->SetErrorMessage( form("Error: parameter %d must be a string.",pIndex) );
  819.             this->SetErrorMessage( "Error: parameter must be a string." );
  820.             return paramErr;
  821.         }
  822.     }
  823.     
  824.     return noErr;
  825. }
  826.  
  827. //—————————————————————————————————————————————————————————————————————————————————————
  828. //    Request::ExtractValueFromNthParam    -    Assign a Boolean from a Boolean parameter 
  829. //                This method stores a Boolean into a Boolean variable.
  830. //—————————————————————————————————————————————————————————————————————————————————————
  831. OSErr
  832. Request::ExtractValueFromNthParam( short pIndex, Boolean* pBooleanPtr )
  833. {
  834.     OSErr            tErr;
  835.     ScriptValue*    tParam;
  836.     ValueKind        tKind;
  837.     
  838.         //————    Specify any kind of VUValue at first
  839.         //————    GetNthParam sets tKind to the actual kind of tParam returned
  840.     tKind = kVUAnyKind;                    
  841.     tErr = this->GetNthParam( pIndex, tParam, tKind );
  842.     
  843.     if ( tErr != noErr ) {
  844.         this->SetErrorCode( tErr );
  845. //        this->SetErrorMessage( form("Failed to extract parameter %d", pIndex) );
  846.         this->SetErrorMessage( "Failed to extract a parameter" );
  847.         return tErr;
  848.     }
  849.     
  850.     switch (tKind)
  851.     {
  852.             //————    we want a Boolean
  853.         case kVUBooleanKind:
  854.         {
  855.             *pBooleanPtr = ((VUBoolean*)tParam)->GetBoolean();
  856.         }
  857.         break;
  858.         
  859.         default:
  860.         {
  861.             this->SetErrorCode( paramErr );
  862. //            this->SetErrorMessage( form("Error: parameter %d must be a Boolean.",pIndex) );
  863.             this->SetErrorMessage( "Error: parameter must be a Boolean." );
  864.             return paramErr;
  865.         }
  866.     }
  867.     
  868.     return noErr;
  869. }
  870.